Developer APIs

  • MapRecorder provides functions to record and replay API calls of a Map instance. These recordings can be used to debug issues which requie multiple steps to reproduce. Additionaly, playbacks can be used for performance testing custom scenarios.

    Note: The file format produced by MapRecorder is experimental and there is no guarantee for version cross-compatibility. The set of recorded APIs and their paramters might change in future releases.

    See more

    Declaration

    Objective-C

    
@interface MBMMapRecorder : NSObject

    Swift

    class MapRecorder : NSObject

  • Undocumented

    Declaration

    Objective-C

    NS_SWIFT_NAME(PlaybackFinished)
typedef void (^MBMPlaybackFinished)()

    Swift

    typealias PlaybackFinished = () -> Void

  • Options for playback.

    See more

    Declaration

    Objective-C

    
@interface MBMMapPlayerOptions : NSObject

    Swift

    class MapPlayerOptions : NSObject

  • Options for recording.

    See more

    Declaration

    Objective-C

    
@interface MBMMapRecorderOptions : NSObject

    Swift

    class MapRecorderOptions : NSObject

  • Performance statistics are collected at the end of the configured window.

    Note: It will be emitted only if performance statistics collection is enabled on the map.

    See more

    Declaration

    Objective-C

    
@interface MBMPerfStatsCollected : NSObject

    Swift

    class PerfStatsCollected : NSObject

  • Options used to configure performance sampling

    See more

    Declaration

    Objective-C

    
@interface MBMPerfStatsCollectionOptions : NSObject

    Swift

    class PerfStatsCollectionOptions : NSObject

  • Undocumented

    Declaration

    Objective-C

    NS_SWIFT_NAME(PerfStatsCollectedCallback)
typedef void (^MBMPerfStatsCollectedCallback)(MBMPerfStatsCollected * _Nonnull perfStatsCollected)

    Swift

    typealias PerfStatsCollectedCallback = (MBMPerfStatsCollected) -> Void

  • Samplers which can be optionally enabled to collect performance statistics

    See more

    Declaration

    Objective-C

    enum MBMPerfSamplerOptions : NSInteger {}

    Swift

    enum PerfSamplerOptions : Int, @unchecked Sendable

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMTracing : NSObject

// This class provides custom init which should be called
- (nonnull instancetype)init NS_UNAVAILABLE;

// This class provides custom init which should be called
+ (nonnull instancetype)new NS_UNAVAILABLE;

+ (void)setTracingBackendTypeForType:(MBMTracingBackendType)type;
+ (MBMTracingBackendType)getTracingBackendType;

@end

    Swift

    class Tracing : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, MBMTracingBackendType)
{
    /**
     * The `Noop` backend introduces no overhead and does not produce any trace marks.
     * The `Noop` backend is used by default, and the enumeration value can be used to
     * disable tracing if needed.
     */
    MBMTracingBackendTypeNoop,
    /**
     * Tracing backend specific to the operating system.
     * For example, Signpost for the iOS or Android Trace for the Android platform.
     */
    MBMTracingBackendTypePlatform,
    /** Tracing backend that prints Perfetto-compatible trace marks to the platform log subsystem. */
    MBMTracingBackendTypeLogger
}

    Swift

    enum TracingBackendType : Int, @unchecked Sendable

  • Undocumented

    Declaration

    Objective-C

    NSString* MBMTracingBackendTypeToString(MBMTracingBackendType tracing_backend_type)

    Swift

    func MBMTracingBackendTypeToString(_ tracing_backend_type: TracingBackendType) -> String!